Interface: SHOP - Promotion code Version 2020.20

This documentation describes the AbaConnect Interface Promotion code for the SHOP Application.


General Information

General information about the AbaConnect interface.

AbaConnect Interface Information
Application :SHOP
Interface Name :Promotion code
ID :XML PromotionCode ( Masterdata )
Version :2020.20
Status:Productive


Displays the possible import and export features for this interface.

Export / Import Modus
Export :XML
Import :XML


Displays additional information for this interface.

Additional Information

                                  Highest field Revision for this interface : 0



Mapping Information

The following displays the Mapping details for this interface.

Mapping Information
Mapping ID :AbaDefault
Mapping Name :Promotion code
Description :

                



Example AbaConnect XML Structure

The following is an example of an XML Header structure. This information is also visible in an AbaConnect XML Export file, that has been exported via the Abacus AbaConnect User Interface.

AbaConnect XML Struktur
<?xml version='1.0' encoding='UTF-8'?>
<AbaConnectContainer>
  <TaskCount>1</TaskCount>
  <Task>
    <Parameter>
      <Application>SHOP</Application>
      <Id>XML PromotionCode</Id>
      <MapId>AbaDefault</MapId>
      <Version>2020.20</Version>
      <!-- Attention : The client number (Mandant) is optional and implies that the data can only be imported into specified client (Mandant) -->
      <!-- The Client Option (Mandant) only has an influence when importing data. It can be configured in the AbaConnect Export Settings. -->
      <!-- By default, the client number (Mandant) is not written to the export file -->
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <PromotionCode mode='SAVE'>
          <!-- The specific data fields for the AbaConnect interface are included here. -->
      </PromotionCode>
    </Transaction>
  </Task>
</AbaConnectContainer>



Example AbaConnect Command Line

The following includes examples of AbaConnect Command Line. The AbaConnect Command Line is executed with the abaconnectexportconsole.exe and abaconnectimportconsole.exe programmes. The AbaConnect Command Line must be run direct on the Abacus server. More detailed information about AbaConnect Command Line is available on the Abacus Homepage. The following examples serve as starting point for creating a simple command line.

AbaConnect Command Line
Export :
abaconnectexportconsole.exe "/USRuser" "/PWxxx"  "-aSHOP"  "-version2020.20"  "-M7777"  "-acidXML PromotionCode"  "-mapidAbaDefault"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx"  "-aSHOP"  "-version2020.20"  "-M7777"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-importfileX:\data.xml"

N.B. : For importing XML data, it is not necessary to specify the Interface ID and Mapping on the Command Line. This information is contained in the XML Import file.



Mapping Structure

The following displays a simplified mapping structure for this interface.
The XML-Element and Parent-Name are always in english. Click on the row to display additional information.

XML Element Name Field Name Parent Name Type Length Mandatory
PromotionCodePromotion code---Yes
    - PromotionNoPromotion numberPromotionCodeNumber8No
    - PromotionCodePromotion codePromotionCodeText50Yes
    - CurrencyCurrencyPromotionCodeText3Yes
    - ValidFromValid fromPromotionCodeDate/Time-Yes
    - ValidUntilValid toPromotionCodeDate/Time-No
    - TextIDText IdPromotionCodeNumber14No
    - ProductAssortmentNoAssortment numberPromotionCodeNumber14No
    - DiscountInPercentRebate in percentPromotionCodeNumber4No
    - DiscountAmountRebate amountPromotionCodeNumber12No
    - FreePromotionProductFree sale productPromotionCodeNumber8No
    - FreePromoProdQtyqty of free productsPromotionCodeNumber8No
    - IsOneTimePerCustomerOne-time redeemablePromotionCodeBoolean-No
    - AllowedCustomerTypeEligible customersPromotionCodeNumber2No
    - MinOrderValueLimitMinimum order valuePromotionCodeNumber12No



Field Information

The following is a detailed description of the fields used in this interface.

Promotion number
XML Element Name:PromotionNo
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   8Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "PROMOTION_NO")
                    

Promotion code
XML Element Name:PromotionCode
Parent Element:PromotionCode
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "PROMOTION_CODE")
                    

Currency
XML Element Name:Currency
Parent Element:PromotionCode
Field Type:Text
Action Type:Import und Export
Field Length:   3Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "CURRENCY")
                    

Valid from
XML Element Name:ValidFrom
Parent Element:PromotionCode
Field Type:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "VALID_FROM")
                    

Valid to
XML Element Name:ValidUntil
Parent Element:PromotionCode
Field Type:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "VALID_UNTIL")
                    

Text Id
XML Element Name:TextID
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   6
Description:

                                  (The internal field ID for this element is "TEXT_ID")
                    

Assortment number
XML Element Name:ProductAssortmentNo
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   7
Description:

                                  (The internal field ID for this element is "PRODUCT_ASSORTMENT_NO")
                    

Rebate in percent
XML Element Name:DiscountInPercent
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   4Decimal Places:   2Mandatory Field:   NoRevision:   0Ascii ID :   8
Description:

                                  (The internal field ID for this element is "DISCOUNT_IN_PERCENT")
                    
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.

Rebate amount
XML Element Name:DiscountAmount
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   12Decimal Places:   4Mandatory Field:   NoRevision:   0Ascii ID :   9
Description:

                                  (The internal field ID for this element is "DISCOUNT_AMOUNT")
                    
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.

Free sale product
XML Element Name:FreePromotionProduct
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   8Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   10
Description:

                                  (The internal field ID for this element is "FREE_PROMOTION_PRODUCT")
                    

qty of free products
XML Element Name:FreePromoProdQty
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   8Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   11
Description:

                                  (The internal field ID for this element is "FREE_PROMOTION_PRODUCT_QUANTITY")
                    

One-time redeemable
XML Element Name:IsOneTimePerCustomer
Parent Element:PromotionCode
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   12
Description:

                                  (The internal field ID for this element is "IS_ONE_TIME_PER_CUSTOMER")
                    

Eligible customers
XML Element Name:AllowedCustomerType
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   2Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   13
Description:

                                  (The internal field ID for this element is "ALLOWED_CUSTOMER_TYPES")
                    

Minimum order value
XML Element Name:MinOrderValueLimit
Parent Element:PromotionCode
Field Type:Nummer
Action Type:Import und Export
Field Length:   12Decimal Places:   4Mandatory Field:   NoRevision:   0Ascii ID :   14
Description:

                                  (The internal field ID for this element is "MIN_ORDER_VALUE_LIMIT")
                    
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.